Skip to main content

Cancel Pix Scheduling

Cancel Scheduled Automatic Pix

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/scheduling/:endToEnd/cancel'

Headers

NameDescription                            
AuthorizationRequired. API key
x-delfinance-account-idRequired. The Delfinance bank account number

Path Parameters:

NameTypeDescription
endToEndIdstringRequired. Authorization identifier

Body Parameters:

NameTypeDescription
CancellationRequesterTypeenumOptional. Who requested the cancellation. Domains:
PAYER
RECEIVER
ReceiverIspbstringOptional. The ISPB of the receiver
RequesterIspbstringOptional. The ISPB of the requester
CancellationReqDocumentstringOptional. The document of the requester (CPF/CNPJ)
PayerAccountTypeenumOptional. Type of person requesting. Domains:
NATURAL
LEGAL
BeneficiaryConciliationIdstringOptional. Receiver conciliation ID
CancellationReasonenumRequired. Reason for the cancellation. See the valid options below.

Cancellation Reasons

ReasonDescription
ACCOUNT_CLOSEDAccount was closed
ACCOUNT_BLOCKEDAccount was blocked
AUTHORIZATION_CANCELLEDAuthorization was cancelled
SETTLEMENT_ERRORError during settlement
OTHER_PARTICIPANT_REQUESTRequested by another participant
REQUESTED_BY_PAYERRequested by the payer
REQUESTED_BY_PAYEERequested by the receiver
{
"CancellationRequesterType": "PAYER",
"ReceiverIspb": "00000000",
"RequesterIspb": "38224857",
"CancellationReqDocument": "12345678901",
"PayerAccountType": "NATURAL",
"BeneficiaryConciliationId": "123e4567-e89b-12d3-a456-426614174000",
"CancellationReason": "ACCOUNT_CLOSED"
}

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
"id": "5448c3b2-3dc0-4dc6-b220-40d5fa04b4b4",
"recurrenceId": "RR38224857202508303nju144fo11",
"beneficiaryReconciliationId": "auto5af01ab71f394e689b4713c1495fa",
"requestedAt": "2026-04-20T00:00:02.635Z",
"endToEndId": "E38224857202604301500IBC533ZMLRB"
}